% File:     usecase.tex
% Author:   Ryan J. Bovorasmy
% Date:     2007-06-24
% Desc:     This template is used to add a use case to the srs.tex template.
% Rev:      [2007-06-24, Ryan J. Bovorasmy] First major revision.
%

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%
%% INSTRUCTIONS:
%%
%% This document can be used to create a use case for use with the srs.tex
%% template.
%%
%% Certain sections (such as this one) are delimited with special comments.
%% These sections contain similar material, and should be treated as a group.
%%
%% Comments beginning with *** indicate that editing is necessary in that
%% area. Example:
%%
%% *** Section description. This section needs editing.
%%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

%||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
%
% BEGIN COMMAND SECTION
% Do Not edit this section unless you know what you are doing.
%
\providecommand{\usecase}{~}
\providecommand{\usehistory}{~}
\providecommand{\uc}{UC\theusecase}
\providecommand{\actor}{~}
\providecommand{\system}{~}
\setcounter{flownumber}{0}
\providecommand{\flowcounter}{\addtocounter{flownumber}{1} \theflownumber}
%
% END COMMAND SECTION
%
%||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||

%==============================================================================
%
% BEGIN VARIABLE SECTION
%
% *** Enter the name of the use case here:
%
\renewcommand{\usecase}{User Runs a Simulation}
%
% *** Enter the revision history here.
% The format of the history command is as follows:
%
% \history{NAME}{DATE}{BRIEF DESCRIPTION\\}
%
% Notice that a newline is REQUIRED after the description.
%
\renewcommand{\usehistory}%
{%
  \history{Kieran Easter}{2007-10-18}{Use Case skeleton created.\\}
  \history{Kieran Easter}{2007-10-24}{Initial version.\\}

}
%
% END VARIABLE SECTION
%
%==============================================================================
\addtocounter{usecase}{1}
\subsection{\uc{}: \usecase{}}

%------------------------------------------------------------------------------
% Do not edit this.
%
\paragraph{\uc{}: Revision History}~\\{}
~\\{}
\begin{table}[htbp]
  \begin{tabular}{|l|l|p{.4\textwidth}|}
    \usehistory
    \hline
  \end{tabular}
\end{table}
%\paragraph{\uc{}: Specification}
%\usecase{}

%------------------------------------------------------------------------------
% *** Enter a brief description.
%
\paragraph{\uc{}: Brief Description}
The user begins a simulation.

% %------------------------------------------------------------------------------
% % *** Image/model
% %
% % Uncomment this section if you would like to add an image of the use case
% % here.
% %
% \paragraph{\uc{}: Model}
% If graphics are being used, add an image of the use case here.

%------------------------------------------------------------------------------
% ** Create a list of actors.
%
\paragraph{\uc{}: Actors}
\begin{description}
  \item[User] The user of the ProtoVitae software.
  \item[ProtoVitae] The ProtoVitae software.
\end{description}

%------------------------------------------------------------------------------
% *** Pre-conditions.
%
\paragraph{\uc{}: Pre-Conditions}
\begin{description}
  \item[Environment Created] An environment has been set up and is loaded into memory.
  \item[Organism Created] At least one organism has been created and is loaded into the environment.
\end{description}

%------------------------------------------------------------------------------
% *** Basic flow.
%
% First enter in the actor name and system name.
%
\renewcommand{\actor}{User}
\renewcommand{\system}{ProtoVitae}
\paragraph{\uc{}: Basic Flow}~\\{}~\\{}
~\\{}~\\{}
\begin{tabular}{|c|p{.4\textwidth}|p{.4\textwidth}|}
  \hline
  \# & \actor{} & \system{} \\
  \hline
  %
  % *** Next, create the rows of the table.
  % Because only one person can be acting at a time, each row should contain
  % one space. Replace the other space with the action.
  %
  \flowcounter{} & Informs ProtoVitae to start the simulation. & ~ \\
  \hline
  \flowcounter{} & ~ & Starts the simulation time flow. \\
  \hline
\end{tabular}


%------------------------------------------------------------------------------
% *** Alternative flow.
%
%\paragraph{\uc{}: Alternative Flows}
%\begin{description}
%  \item{FLOW} Description.
%  \item{FLOW} Description.
%\end{description}

%------------------------------------------------------------------------------
% *** Exception flow.
%
\paragraph{\uc{}: Exception Flows}
\begin{description}
  \item[Simulation Data Error] In the event of a data error, the system shall not start the simulation.
\end{description}

%------------------------------------------------------------------------------
% *** Post-conditions.
%
\paragraph{\uc{}: Post-Conditions}
\begin{description}
  \item[Simulation Running] The simulation is running within normal parameters.
\end{description}

%------------------------------------------------------------------------------
% *** Enter any additional notes here.
%
%\paragraph{\uc{}: Additional Notes}
%Any additional notes.
